package org.example.dto;

/**
 * 通用API响应类
 * 用于统一所有API接口的响应格式
 * 包含响应码、消息、数据和时间戳
 * 
 * @author Your Name
 * @since 2024-07-01
 */
public class ApiResponse<T> {
    
    /**
     * 响应码，表示操作的结果状态
     * 200表示成功，其他值表示各种错误
     */
    private Integer code;
    
    /**
     * 响应消息，描述操作结果
     * 成功时显示"操作成功"，失败时显示错误原因
     */
    private String message;
    
    /**
     * 响应数据，泛型T表示具体的数据类型
     * 成功时包含返回的数据，失败时可能为null
     */
    private T data;
    
    /**
     * 时间戳，记录响应生成的时间
     * 用于调试和日志记录
     */
    private Long timestamp;
    
    // ==================== 构造函数 ====================
    
    /**
     * 无参构造函数
     * 自动设置时间戳为当前时间
     */
    public ApiResponse() {
        // 设置时间戳为当前时间的毫秒数
        this.timestamp = System.currentTimeMillis();
    }
    
    /**
     * 带码和消息的构造函数
     * 
     * @param code 响应码
     * @param message 响应消息
     */
    public ApiResponse(Integer code, String message) {
        this(); // 调用无参构造函数设置时间戳
        this.code = code;
        this.message = message;
    }
    
    /**
     * 完整构造函数
     * 
     * @param code 响应码
     * @param message 响应消息
     * @param data 响应数据
     */
    public ApiResponse(Integer code, String message, T data) {
        this(code, message); // 调用两参构造函数
        this.data = data;
    }
    
    // ==================== 静态工厂方法 ====================
    
    /**
     * 创建成功响应（无数据）
     * 
     * @param <T> 数据类型
     * @return 成功响应对象
     */
    public static <T> ApiResponse<T> success() {
        return new ApiResponse<>(200, "操作成功");
    }
    
    /**
     * 创建成功响应（带数据）
     * 
     * @param <T> 数据类型
     * @param data 响应数据
     * @return 成功响应对象
     */
    public static <T> ApiResponse<T> success(T data) {
        return new ApiResponse<>(200, "操作成功", data);
    }
    
    /**
     * 创建成功响应（自定义消息和数据）
     * 
     * @param <T> 数据类型
     * @param message 自定义成功消息
     * @param data 响应数据
     * @return 成功响应对象
     */
    public static <T> ApiResponse<T> success(String message, T data) {
        return new ApiResponse<>(200, message, data);
    }
    
    /**
     * 创建错误响应（默认错误码500）
     * 
     * @param <T> 数据类型
     * @param message 错误消息
     * @return 错误响应对象
     */
    public static <T> ApiResponse<T> error(String message) {
        return new ApiResponse<>(500, message);
    }
    
    /**
     * 创建错误响应（自定义错误码和消息）
     * 
     * @param <T> 数据类型
     * @param code 错误码
     * @param message 错误消息
     * @return 错误响应对象
     */
    public static <T> ApiResponse<T> error(Integer code, String message) {
        return new ApiResponse<>(code, message);
    }
    
    // ==================== Getter和Setter方法 ====================
    
    /**
     * 获取响应码
     * @return 响应码
     */
    public Integer getCode() {
        return code;
    }
    
    /**
     * 设置响应码
     * @param code 响应码
     */
    public void setCode(Integer code) {
        this.code = code;
    }
    
    /**
     * 获取响应消息
     * @return 响应消息
     */
    public String getMessage() {
        return message;
    }
    
    /**
     * 设置响应消息
     * @param message 响应消息
     */
    public void setMessage(String message) {
        this.message = message;
    }
    
    /**
     * 获取响应数据
     * @return 响应数据
     */
    public T getData() {
        return data;
    }
    
    /**
     * 设置响应数据
     * @param data 响应数据
     */
    public void setData(T data) {
        this.data = data;
    }
    
    /**
     * 获取时间戳
     * @return 时间戳
     */
    public Long getTimestamp() {
        return timestamp;
    }
    
    /**
     * 设置时间戳
     * @param timestamp 时间戳
     */
    public void setTimestamp(Long timestamp) {
        this.timestamp = timestamp;
    }
}
